package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.SocDifferenceAddDTO;
import org.jsola.hr.dto.SocDifferenceUpdateDTO;
import org.jsola.hr.query.SocDifferenceQuery;
import org.jsola.hr.vo.SocDifferenceListVO;
import org.jsola.hr.vo.SocDifferenceVO;

import java.util.List;

/**
 * 员工参保差额费用记录
 *
 * @author zhr
 */
@Api(tags = "hr-员工参保差额费用记录")
public interface ISocDifferenceControllerAPI {

    /**
     * 新增员工参保差额费用记录
     * @param socDifferenceAddDTO 员工参保差额费用记录新增实体
     * @return 员工参保差额费用记录展示对象
     */
    @ApiOperation(value = "新增员工参保差额费用记录")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "socDifferenceAddDTO", dataType = "SocDifferenceAddDTO", value = "新增员工参保差额费用记录", paramType = "body")
    })
    Result<SocDifferenceVO> save(SocDifferenceAddDTO socDifferenceAddDTO);


    /**
     * 修改员工参保差额费用记录
     * @param socDifferenceUpdateDTO 员工参保差额费用记录
     * @return 更新数量
     */
    @ApiOperation(value = "修改员工参保差额费用记录")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "socDifferenceUpdateDTO", dataType = "SocDifferenceUpdateDTO", value = "修改员工参保差额费用记录", paramType = "body")
    })
    Result<Integer> update(SocDifferenceUpdateDTO socDifferenceUpdateDTO);




    /**
     * 删除单个员工参保差额费用记录，彻底删除
     * @param socDifferenceId 员工参保差额费用记录id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个员工参保差额费用记录，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "socDifferenceId", dataType = "String", value = "员工参保差额费用记录id", paramType = "path")
    })
    Result<Integer> delete(String socDifferenceId);


    /**
     * 批量删除员工参保差额费用记录，彻底删除
     * @param socDifferenceIds 员工参保差额费用记录id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除员工参保差额费用记录，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "socDifferenceIds", dataType = "String[]", value = "员工参保差额费用记录id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] socDifferenceIds);


    /**
     * 根据员工参保差额费用记录id查询员工参保差额费用记录详情
     * @param socDifferenceId 员工参保差额费用记录id
     * @return 员工参保差额费用记录详情
     */
    @ApiOperation(value="根据员工参保差额费用记录id查询员工参保差额费用记录详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "socDifferenceId", dataType = "String", value = "员工参保差额费用记录id", paramType = "path")
    })
    Result<SocDifferenceVO> findById(String socDifferenceId);


    /**
     * 查询员工参保差额费用记录
     * @param socDifferenceQuery 员工参保差额费用记录查询参数
     * @return page
     */
    @ApiOperation(value="查询员工参保差额费用记录")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "socDifferenceQuery", dataType = "SocDifferenceQuery", value = "员工参保差额费用记录查询参数", paramType = "query")
    })
    Result<List<SocDifferenceListVO>> listAll(SocDifferenceQuery socDifferenceQuery);


     /**
     * 分页查询员工参保差额费用记录
     * @param socDifferenceQuery 员工参保差额费用记录查询参数
     * @return page
     */
    @ApiOperation(value="分页查询员工参保差额费用记录")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "socDifferenceQuery", dataType = "SocDifferenceQuery", value = "员工参保差额费用记录查询参数", paramType = "query")
    })
    Result<Page<SocDifferenceListVO>> page(SocDifferenceQuery socDifferenceQuery);


}

